home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / dug104.zip / DUG.DOC < prev    next >
Text File  |  1993-01-13  |  11KB  |  293 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                  Garth Bigelow
  9.  
  10.                              TopherSoft Engineering
  11.  
  12.  
  13.                                       DUG
  14.                                 Door Usage Graph
  15.  
  16.                                     01/12/93
  17.  
  18.  
  19.      DUG is an extremely easy to use yet fairly flexable Door Usage Graph
  20.      generator. DUG will create color bulletins using any color code format.
  21.  
  22.  
  23.  
  24.                        DUG - Door Usage Graph Generator
  25.  
  26.  
  27.                              TopherSoft Engineering
  28.  
  29.  
  30.                                 RR620 State Road
  31.                             Vineyard Haven, MA 02568
  32.                TopherSoft BBS: 508-693-7396 Speed 1200,2400,19200
  33.  
  34.      ***********************************************************************
  35.      DUG copyright (c) 1993 by TopherSoft Engineering & Garth Bigelow.
  36.      DUG is distributed as Shareware. You are free to inspect DUG on a trail
  37.      basis for 30 days. If after thirty days you wish to continue using DUG
  38.      you must Register the program (See the end of this documentation for
  39.      details) otherwise you must remove DUG from your system.
  40.      I have included NO crippling code in DUG. Also no delays or "pester"
  41.      screens have been included. What you see is what you get.
  42.      Responce to this approach will determine whether future TopherSoft
  43.      products contain features available only thru Registration or whether
  44.      we produce more products like DUG that are fully functional from the
  45.      start.
  46.      ***********************************************************************
  47.  
  48.  
  49.  
  50.  
  51.  
  52.      1.  Installation
  53.  
  54.      The Installation of DUG has been designed to be as simple as possible
  55.      for a utility of it's type.
  56.  
  57.      Installation consists of three steps.
  58.  
  59.      Step 1: Copy DUG.EXE & DUG.CF into a sub-directory that is in the path.
  60.  
  61.              Example: Copy DUG.* \BBS
  62.  
  63.              [Optionally an Enviromental Variable DUG can be set up to
  64.               point to DUG.EXE.
  65.  
  66.               Example: SET DUG=\BBS\
  67.              ]
  68.  
  69.      Step 2: Edit DUG.CF 
  70.  
  71.              DUG.CF contains eleven commented lines, looking something
  72.              like this:
  73.           --------------------------------------------------
  74.           D:\BBS\INCLUDES\DOORUSE.ANS
  75.           20            Maximum Number of Doors to Display (Example: Top 20)
  76.           A             Ranking Method (A = By Accesses, M = by Minutes Used)
  77.           -             Color Code Terminator
  78.           $             Escape Character Code
  79.           $[0;36m-      Color Code For Titles
  80.           $[1;31m-      Color Code For Door Names
  81.           $[1;34m-      Color Code For Access Bar
  82.           $[0;31m-      Color Code For Last Access
  83.           $[0;32m-      Color Code For Uage Time Average Bar
  84.           $[0;37m-      Color Code To Return to Normal
  85.           --------------------------------------------------
  86.  
  87.              Unless you wish to use a color code scheme other than
  88.              ANSI.SYS escape codes (such as Searchlight Color Codes)
  89.              the first line of DUG.CF is probably the only one that
  90.              needs to be changed.
  91.  
  92.              Line  1: This must be the name and path of the Door Usage
  93.                       Graph being created.
  94.              Line  2: Describes how many Doors to List on Graph.
  95.                       The Top 20, The Top 5, etc.
  96.              Line  3: Is the Ranking Method.
  97.                       "M" rankings the graph by the Number of Minutes Bar.
  98.                       Any other key ranks by Number of Accesses.
  99.              Line  4: Is the Character that will be used to end signify
  100.                       the end of a color color.
  101.                       Any character that is not used in your color codes
  102.                       may be used.
  103.              Line  5: ESC characters are difficult to type in most edits
  104.                       but are part of a many color code schemes. This line
  105.                       specifies a character that will be translated into
  106.                       an ESC in the color code lines below.
  107.              Line  6: This is the Color Code Sequence for the Titles.
  108.              Line  7: This is the Color Code Sequence for the Door Names.
  109.              Line  8: This is the Color Code Sequence for the Number of
  110.                       Accesses Bar on the Graph.
  111.              Line  9: This is the Color Code Sequence for the Last Access
  112.                       Info.
  113.              Line 10: This is the Color Code Sequence for the Minutes of
  114.                       Usage Bar on the Graph.
  115.              Line 11: This is the Color Code Sequence that is displayed at
  116.                       the end to return the color to normal.
  117.  
  118.  
  119.      Step 3: Hook DUG into the BBS's Doors.
  120.              This is the hardest part, merely because you have to do
  121.              this step for every Door that you want to be included in
  122.              the Usage Graph.
  123.  
  124.  
  125.              This Step requires adding two line to each BAT file that
  126.              runs each door. [Note: If you are running the door directly
  127.              you will have to set up a BAT file to run it before proceeding
  128.              with this step.]
  129.  
  130.              The Lines to add are:
  131.                  DUG "door name" IN
  132.                  DUG "door name" OUT
  133.  
  134.              These lines are included so that they stradle the program
  135.              being run.
  136.  
  137.              Let's say one of your doors is Ultimate Universe and your
  138.              BAT file to run it looks like this:
  139.  
  140.              -----------------------------------------------------------
  141.              @ECHO OFF
  142.              CD\BBS\DOORS\UU
  143.              ULTIMATE -%1 -P%2 -T%3 /P%4 /B%5
  144.              Copy RANK.U? \BBS\INCLUDES >nul
  145.              COPY NEWPAPER.U?U \BBS\INCLUDES >nul
  146.              CD\BBS
  147.              -----------------------------------------------------------
  148.  
  149.              The BAT file should be modified to look like this:
  150.  
  151.              -----------------------------------------------------------
  152.              @ECHO OFF
  153.              CD\BBS\DOORS\UU
  154.              DUG "Ultimate Universe" IN
  155.              ULTIMATE -%1 -P%2 -T%3 /P%4 /B%5
  156.              DUG "Ultimate Universe" OUT
  157.              Copy RANK.U? \BBS\INCLUDES >nul
  158.              COPY NEWPAPER.U?U \BBS\INCLUDES >nul
  159.              CD\BBS
  160.              -----------------------------------------------------------
  161.  
  162.              It is very important that the door name be the same in both
  163.              lines, including Upper and Lower case.
  164.              And, yes the quotes are needed.
  165.  
  166.              [Note: If you just wish to track the usage and not the time
  167.              the second (OUT) line may be omitted.]
  168.  
  169.  
  170.       -----------------------------------------------------------------------
  171.  
  172.  
  173.       That's it! Your Door Usage Graph is now ready to be displayed.
  174.  
  175.  
  176.       Additional Commands
  177.  
  178.       There are two addition commands for maintaining the graph. These
  179.       commands are SET and RESET.
  180.  
  181.  
  182.       RESET:   RESET is used to remove a door from an existing graph file.
  183.                The syntax is:
  184.  
  185.                      DUG "door name" RESET
  186.  
  187.                If you remove a door from your BBS, this command will let
  188.                you remove it from the graph.
  189.  
  190.  
  191.       SET:     SET is for use well switching over from another Door Graph
  192.                program. This allows you to preset the information for the
  193.                graph.
  194.                The syntax is:
  195.  
  196.                      DUG "door name" SET accesses [minutes]
  197.  
  198.                This sets the number of times accessed and minutes used
  199.                values for door name.
  200.                If minutes is omitted it will be set to zero.
  201.                If accesses is omitted SET is ignored.
  202.  
  203.  
  204.       An additional option also exists for OUT and RESET:
  205.  
  206.       NOGRAPH: The NOGRAPH option looks like this:
  207.  
  208.                      DUG "door name" OUT NOGRAPH
  209.  
  210.                This option forces DUG to terminate before it creates the
  211.                Door Usage Graph. Thus if you only want the graph updated
  212.                at certain times (like daily) this option allows that.
  213.                This option is mostly for use on XTs where the time taken
  214.                to create the graph file name be noticeable.
  215.  
  216.                Note: You can force a graph by resetting a non-existant
  217.                      graph entry, like se:
  218.  
  219.                          DUG "fake door name" RESET
  220.  
  221.                IN will accept the NOGRAPH parameter but as IN does not
  222.                create a graph it is redundant.
  223.  
  224.  
  225.  
  226.  
  227.      The Legalities
  228.  
  229.  
  230.      1  Sharing DUG Files
  231.  
  232.      You are welcome to share unmodified copies of DUG.ZIP with your friends
  233.      and associates for their evaluation.  This documentation and the config-
  234.      uration file (DUG.CF) must be provided with all copies of DUG except
  235.      by prior written permission from TopherSoft Engineering.
  236.  
  237.      Unmodified copies of TopherSoft Engineering shareware and demo files
  238.      including DUG.ZIP may be distributed by "shareware distributors"
  239.      provided:
  240.         1) the files are clearly identified as shareware,
  241.         2) the cost of the distribution is nominal.
  242.      Otherise, no version of DUG may be sold without the prior written
  243.      permission of TopherSoft Engineering.
  244.  
  245.      Distribution of DUG in any medium without this documentation file is an
  246.      unauthorized modification to DUG that deprives the rightful author of
  247.      registration revenues.  That is a theft of intellectual property.  Such
  248.      distribution damages the author by forcing the user and author to waste
  249.      time and phone bills scrounging for the documentation, and answering
  250.      questions that are fully covered in the documentation.
  251.  
  252.      Thank you for your support.
  253.  
  254.  
  255.  
  256.  
  257.      The Registration
  258.  
  259.      After a short evaluation period, of not more than 30 days, ethical users
  260.      must register their copy of DUG with a check for $15.00 or more) in U.S.
  261.      funds.
  262.      DO NOT send the funds to me, please make the check or money order out to:
  263.  
  264.             Hubbard Diantics Foundation
  265.  
  266.      and send to:
  267.  
  268.             Hubbard Diantics Foundation
  269.             3009 N. Lincoln
  270.             Chicago, IL 60657
  271.             RE: Freeloader Fund
  272.             ATTN: Gary Kveton
  273.  
  274.      In a very real sense I would not have the creative ability to be a
  275.      shareware software author without their help and patience a few years
  276.      ago. It's time to give something back.
  277.  
  278.  
  279.      The funds are sufficient, I see no reason to make you fill out forms.
  280.  
  281.      But please remember that Registration is the only encouragement a
  282.      Shareware author gets. If you use the program beyond the trail period
  283.      then the program has value to you and thus the author should be
  284.      reimbursed for that value.
  285.  
  286.      Piracy is stealing.
  287.  
  288.      Only you make shareware work.
  289.  
  290.  
  291.  
  292.  
  293.